home *** CD-ROM | disk | FTP | other *** search
/ Stone Design / Stone Design.iso / Stone_Friends / Wave / WavesWorld / Source / Libraries / tcl7.4b3 / doc / break.n < prev    next >
Encoding:
Text File  |  1994-12-17  |  1.0 KB  |  35 lines
  1. '\"
  2. '\" Copyright (c) 1993-1994 The Regents of the University of California.
  3. '\" Copyright (c) 1994 Sun Microsystems, Inc.
  4. '\"
  5. '\" See the file "license.terms" for information on usage and redistribution
  6. '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  7. '\" 
  8. '\" @(#) break.n 1.3 94/12/17 16:17:40
  9. '\" 
  10. .so man.macros
  11. .HS break tcl
  12. .BS
  13. '\" Note:  do not modify the .SH NAME line immediately below!
  14. .SH NAME
  15. break \- Abort looping command
  16. .SH SYNOPSIS
  17. \fBbreak\fR
  18. .BE
  19.  
  20. .SH DESCRIPTION
  21. .PP
  22. This command is typically invoked inside the body of a looping command
  23. such as \fBfor\fR or \fBforeach\fR or \fBwhile\fR.
  24. It returns a TCL_BREAK code, which causes a break exception
  25. to occur.
  26. The exception causes the current script to be aborted
  27. out to the the innermost containing loop command, which then
  28. aborts its execution and returns normally.
  29. Break exceptions are also handled in a few other situations, such
  30. as the \fBcatch\fR command, Tk event bindings, and the outermost
  31. scripts of procedure bodies.
  32.  
  33. .SH KEYWORDS
  34. abort, break, loop
  35.